Skip to main content

Interface: EventSignals

Properties​

onBreakoutBegin​

• onBreakoutBegin: Signal<BreakoutRoom>

onBreakoutEnd​

• onBreakoutEnd: Signal<BreakoutRoom>

onBreakoutEvent​

• onBreakoutEvent: Signal<Object>

onBreakoutRefer​

• onBreakoutRefer: Signal<{ breakout_uuid: string }>

onCallDisconnected​

• onCallDisconnected: Signal<CallDisconnectedEvent>

onConferenceUpdate​

• onConferenceUpdate: Signal<ConferenceStatus>

onConnected​

• onConnected: Signal<undefined>

onDisconnect​

• onDisconnect: Signal<DisconnectEvent>

onError​

• onError: Signal<undefined>

onFecc​

• onFecc: Signal<FeccEvent>

onHold​

• onHold: Signal<boolean>

onLayoutUpdate​

• onLayoutUpdate: Signal<LayoutEvent>

onLiveCaptions​

• onLiveCaptions: Signal<LiveCaptionsEvent>

onMessage​

• onMessage: Signal<MessageEvent>

onNewCandidate​

• onNewCandidate: Signal<IceCandidate>

onNewOffer​

• onNewOffer: Signal<{ sdp: string }>

onParticipantCreate​

• onParticipantCreate: Signal<Participant>

onParticipantDelete​

• onParticipantDelete: Signal<string>

onParticipantSyncBegin​

• onParticipantSyncBegin: Signal<undefined>

onParticipantSyncEnd​

• onParticipantSyncEnd: Signal<undefined>

onParticipantUpdate​

• onParticipantUpdate: Signal<Participant>

onPeerDisconnect​

• onPeerDisconnect: Signal<undefined>

onPresentationEnded​

• onPresentationEnded: Signal<undefined>

onPresentationFrame​

• onPresentationFrame: Signal<string>

onPresentationStart​

• onPresentationStart: Signal<NormalizedPresentationEvent>

onPresentationStop​

• onPresentationStop: Signal<undefined>

onRefer​

• onRefer: Signal<{ alias: string ; breakout_name?: string ; target?: "conference" | "breakout" | "main" ; token: string }>

onRefreshToken​

• onRefreshToken: Signal<undefined>

onSplashScreen​

• onSplashScreen: Signal<null | { display_duration: number ; screen_key: keyof Result1 }>

onStageUpdate​

• onStageUpdate: Signal<StageEvent[]>

onUpdateSdp​

• onUpdateSdp: Signal<{ sdp: string }>